<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>IDA SDK: form_actions_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">IDA SDK
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="files.html"><span>Header&#160;Files</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structform__actions__t-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">form_actions_t Struct Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Functions available from <a class="el" href="kernwin_8hpp.html#a435eebdaa696149cdba8213abf460465" title="Callback. ">formchgcb_t</a>. </p>
<p>For getters/setters for specific field values, see <a class="el" href="kernwin_8hpp.html#a3f7c11ec98ea8b7337472fe1472b4d60" title="Helper to define functions in form_actions_t that get/set field values of different types...">DEF_SET_METHOD</a>. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4d3dec6bf66b73d8023f0c6193506290"><td class="memItemLeft" align="right" valign="top">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structform__actions__t.html#a4d3dec6bf66b73d8023f0c6193506290">_get_field_value</a> (int field_id, void *buf)=0</td></tr>
<tr class="memdesc:a4d3dec6bf66b73d8023f0c6193506290"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get value of an input field.  <a href="#a4d3dec6bf66b73d8023f0c6193506290">More...</a><br /></td></tr>
<tr class="separator:a4d3dec6bf66b73d8023f0c6193506290"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40386de52f612518d16c287f5c992c39"><td class="memItemLeft" align="right" valign="top">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structform__actions__t.html#a40386de52f612518d16c287f5c992c39">_set_field_value</a> (int field_id, const void *buf)=0</td></tr>
<tr class="memdesc:a40386de52f612518d16c287f5c992c39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set value of an input field.  <a href="#a40386de52f612518d16c287f5c992c39">More...</a><br /></td></tr>
<tr class="separator:a40386de52f612518d16c287f5c992c39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e64804ec8d822fc2393018bae6003b5"><td class="memItemLeft" align="right" valign="top">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structform__actions__t.html#a3e64804ec8d822fc2393018bae6003b5">enable_field</a> (int field_id, bool enable)=0</td></tr>
<tr class="memdesc:a3e64804ec8d822fc2393018bae6003b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable or disable an input field.  <a href="#a3e64804ec8d822fc2393018bae6003b5">More...</a><br /></td></tr>
<tr class="separator:a3e64804ec8d822fc2393018bae6003b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97b89fd1d9b0c8168f7f9c43c5e5b17e"><td class="memItemLeft" align="right" valign="top">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structform__actions__t.html#a97b89fd1d9b0c8168f7f9c43c5e5b17e">show_field</a> (int field_id, bool display)=0</td></tr>
<tr class="memdesc:a97b89fd1d9b0c8168f7f9c43c5e5b17e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Show or hide an input field.  <a href="#a97b89fd1d9b0c8168f7f9c43c5e5b17e">More...</a><br /></td></tr>
<tr class="separator:a97b89fd1d9b0c8168f7f9c43c5e5b17e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1a6017b90af70c8135ae120528b2c5a"><td class="memItemLeft" align="right" valign="top">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structform__actions__t.html#aa1a6017b90af70c8135ae120528b2c5a">move_field</a> (int field_id, int x, int y, int w, int h)=0</td></tr>
<tr class="memdesc:aa1a6017b90af70c8135ae120528b2c5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move/Resize an input field.  <a href="#aa1a6017b90af70c8135ae120528b2c5a">More...</a><br /></td></tr>
<tr class="separator:aa1a6017b90af70c8135ae120528b2c5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa8e26e685add6aa5e13ea92711e63ea"><td class="memItemLeft" align="right" valign="top">virtual int <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structform__actions__t.html#aaa8e26e685add6aa5e13ea92711e63ea">get_focused_field</a> (void)=0</td></tr>
<tr class="memdesc:aaa8e26e685add6aa5e13ea92711e63ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get currently focused input field.  <a href="#aaa8e26e685add6aa5e13ea92711e63ea">More...</a><br /></td></tr>
<tr class="separator:aaa8e26e685add6aa5e13ea92711e63ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af96071d94bef5e05d0ba842dea87874c"><td class="memItemLeft" align="right" valign="top">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structform__actions__t.html#af96071d94bef5e05d0ba842dea87874c">set_focused_field</a> (int field_id)=0</td></tr>
<tr class="memdesc:af96071d94bef5e05d0ba842dea87874c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set currently focused input field.  <a href="#af96071d94bef5e05d0ba842dea87874c">More...</a><br /></td></tr>
<tr class="separator:af96071d94bef5e05d0ba842dea87874c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab30b0036637c5f6720c89a0a3f55a013"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab30b0036637c5f6720c89a0a3f55a013"></a>
virtual void <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structform__actions__t.html#ab30b0036637c5f6720c89a0a3f55a013">refresh_field</a> (int field_id)=0</td></tr>
<tr class="memdesc:ab30b0036637c5f6720c89a0a3f55a013"><td class="mdescLeft">&#160;</td><td class="mdescRight">Refresh a field. <br /></td></tr>
<tr class="separator:ab30b0036637c5f6720c89a0a3f55a013"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fd269b66a370f61796df8e12c42e844"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9fd269b66a370f61796df8e12c42e844"></a>
virtual void <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structform__actions__t.html#a9fd269b66a370f61796df8e12c42e844">close</a> (int close_normally)=0</td></tr>
<tr class="memdesc:a9fd269b66a370f61796df8e12c42e844"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the form. <br /></td></tr>
<tr class="separator:a9fd269b66a370f61796df8e12c42e844"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9b8b7ec47eb18bd4ffbf423168c7e91"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af9b8b7ec47eb18bd4ffbf423168c7e91"></a>
virtual void *<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structform__actions__t.html#af9b8b7ec47eb18bd4ffbf423168c7e91">get_ud</a> ()=0</td></tr>
<tr class="memdesc:af9b8b7ec47eb18bd4ffbf423168c7e91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the user data specified through %*. <br /></td></tr>
<tr class="separator:af9b8b7ec47eb18bd4ffbf423168c7e91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bafc9e8124384e0eeb3249c9bb26ad1"><td class="memItemLeft" align="right" valign="top">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structform__actions__t.html#a6bafc9e8124384e0eeb3249c9bb26ad1">_get_str_field_value</a> (int field_id, char *buf, const size_t bufsize)=0</td></tr>
<tr class="memdesc:a6bafc9e8124384e0eeb3249c9bb26ad1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get value of an UTF-8 string input field.  <a href="#a6bafc9e8124384e0eeb3249c9bb26ad1">More...</a><br /></td></tr>
<tr class="separator:a6bafc9e8124384e0eeb3249c9bb26ad1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4d3dec6bf66b73d8023f0c6193506290"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> form_actions_t::_get_field_value </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>field_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>buf</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get value of an input field. </p>
<dl class="section return"><dt>Returns</dt><dd>false if no such field id or invalid field type (B) </dd></dl>

</div>
</div>
<a class="anchor" id="a40386de52f612518d16c287f5c992c39"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> form_actions_t::_set_field_value </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>field_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const void *&#160;</td>
          <td class="paramname"><em>buf</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set value of an input field. </p>
<dl class="section return"><dt>Returns</dt><dd>false if no such field id or invalid field type (B) </dd></dl>

</div>
</div>
<a class="anchor" id="a3e64804ec8d822fc2393018bae6003b5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> form_actions_t::enable_field </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>field_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>enable</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Enable or disable an input field. </p>
<dl class="section return"><dt>Returns</dt><dd>false if no such field id </dd></dl>

</div>
</div>
<a class="anchor" id="a97b89fd1d9b0c8168f7f9c43c5e5b17e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> form_actions_t::show_field </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>field_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>display</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Show or hide an input field. </p>
<dl class="section return"><dt>Returns</dt><dd>false if no such field id </dd></dl>

</div>
</div>
<a class="anchor" id="aa1a6017b90af70c8135ae120528b2c5a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> form_actions_t::move_field </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>field_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>w</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>h</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Move/Resize an input field. </p>
<p>Parameters specified as -1 are not modified. </p><dl class="section return"><dt>Returns</dt><dd>false no such field id </dd></dl>

</div>
</div>
<a class="anchor" id="aaa8e26e685add6aa5e13ea92711e63ea"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual int <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> form_actions_t::get_focused_field </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get currently focused input field. </p>
<dl class="section return"><dt>Returns</dt><dd>-1 if no such field </dd></dl>

</div>
</div>
<a class="anchor" id="af96071d94bef5e05d0ba842dea87874c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> form_actions_t::set_focused_field </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>field_id</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set currently focused input field. </p>
<dl class="section return"><dt>Returns</dt><dd>false if no such field id </dd></dl>

</div>
</div>
<a class="anchor" id="a6bafc9e8124384e0eeb3249c9bb26ad1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> form_actions_t::_get_str_field_value </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>field_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const size_t&#160;</td>
          <td class="paramname"><em>bufsize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get value of an UTF-8 string input field. </p>
<dl class="section return"><dt>Returns</dt><dd>false if no such field id or invalid field type (B) </dd></dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="kernwin_8hpp.html">kernwin.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
